[MISC] Move the PR template to a separate directory and improve contents #338
Conversation
|
The effect would be this: Hope folks will find this useful. |
jhlegarreta
force-pushed
the
ImprovePRTemplate
branch
from
4ea91a3
to
06ba8cc
Compare
|
The errors, but none of the two seems to display the URLs contained in the PR template. Any guess? |
|
Looks interesting to me, thanks for the submission. +1 definitely for moving the template into a GitHub folder for clarity in the repository root. Regarding using an HTML comment, I am undecided: It seems a bit cluttery and it'd distract me from writing my issue (I like to delete the template after reading). But I think that's too much a personal opinion to factor in here ... I'd be fine adding it if popular opinion is in favor. @franklin-feingold @effigies what are your opinions? RE: Circle CI:
The HED website seems to be down. This is unrelated to your PR, I think we can ignore it for now and it'll soon be fixed by the responsible people (else, we'll deal with it soon) |
|
I wouldn't use HTML, because the main way people will see this is through the text editor, not the preview mode. It should be easily readable without further action. On the whole, I think the current strategy is fine. If you want to create a template with sections that people use, then HTML comments are useful for describing what's expected and letting people choose whether or not to delete them. A big block of text that asks submitters to delete itself seems to work pretty well at getting people to do what we want. |
|
Thanks for the comments ! Shall I then close this PR and open anew one just moving the file to a |
|
That'd be fine, though feel free to do it in this PR, to keep the conversation in one place. |
Move the PR template to a separate folder to reduce clutter in the root folder, and help identifying more clearly the GitHub-related files. Cross-ref explicitly the `CONTRIBUTING` document. Minor syntax enhancements.
jhlegarreta
force-pushed
the
ImprovePRTemplate
branch
from
06ba8cc
to
dfeb98e
Compare
jhlegarreta
changed the title
|
Done. Please have a look at the new revision dfeb98e . Thanks. |
|
thank you @jhlegarreta for putting this together! +1 for not having the HTML, mostly on what @effigies described. I like moving the template away from the Root! overall LGTM As @sappelhoff said we can ignore the linkchecker because we know it is from HED not rendering right now, not our system. Side point: If they are down for extended time, can consider perhaps finding a way to skip them in validation so it doesn't appear we are failing our CI |
sappelhoff
changed the title
Move the PR template to a separate folder and use HTML syntax.
The first action helps in reducing clutter in the root folder, and helps
identifying more clearly the GitHub-related files.
The HMTL syntax transition using HTML comments allows the PR template
text not to be part of PR message, and saves the user the task of
deleting it while being still clearly visible when opening a PR.
Minor syntax enhancements.